home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 January: Mac OS SDK / Dev.CD Jan 98 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Universal / Interfaces / AIncludes / Threads.a < prev    next >
Encoding:
Text File  |  1997-08-12  |  10.7 KB  |  403 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        Threads.a
  3. ;
  4. ;    Contains:    Thread Manager Interfaces.
  5. ;
  6. ;    Version:    Technology:    System 7.5
  7. ;                Release:    Universal Interfaces 3.0.1
  8. ;
  9. ;    Copyright:    © 1991-1997 by Apple Computer, Inc., all rights reserved.
  10. ;
  11. ;    Bugs?:        Please include the the file and version information (from above) with
  12. ;                the problem description.  Developers belonging to one of the Apple
  13. ;                developer programs can submit bug reports to:
  14. ;
  15. ;                    devsupport@apple.com
  16. ;
  17. ;
  18.     IF &TYPE('__THREADS__') = 'UNDEFINED' THEN
  19. __THREADS__ SET 1
  20.  
  21.     IF &TYPE('__TYPES__') = 'UNDEFINED' THEN
  22.     include 'Types.a'
  23.     ENDIF
  24.     IF &TYPE('__MIXEDMODE__') = 'UNDEFINED' THEN
  25.     include 'MixedMode.a'
  26.     ENDIF
  27.     IF &TYPE('__ERRORS__') = 'UNDEFINED' THEN
  28.     include 'Errors.a'
  29.     ENDIF
  30.  
  31. ;  Thread states 
  32. ; typedef unsigned short                 ThreadState
  33.  
  34.  
  35. kReadyThreadState                EQU        0
  36. kStoppedThreadState                EQU        1
  37. kRunningThreadState                EQU        2
  38. ;  Error codes have been meoved to Errors.(pah) 
  39. ;  Thread environment characteristics 
  40. ; typedef void *                        ThreadTaskRef
  41.  
  42. ;  Thread characteristics 
  43. ; typedef unsigned long                 ThreadStyle
  44.  
  45.  
  46. kCooperativeThread                EQU        $00000001
  47. kPreemptiveThread                EQU        $00000002
  48. ;  Thread identifiers 
  49. ; typedef unsigned long                 ThreadID
  50.  
  51.  
  52. kNoThreadID                        EQU        0
  53. kCurrentThreadID                EQU        1
  54. kApplicationThreadID            EQU        2
  55. ;  Options when creating a thread 
  56. ; typedef unsigned long                 ThreadOptions
  57.  
  58.  
  59. kNewSuspend                        EQU        $01
  60. kUsePremadeThread                EQU        $02
  61. kCreateIfNeeded                    EQU        $04
  62. kFPUNotNeeded                    EQU        $08
  63. kExactMatchThread                EQU        $10
  64. ;  Information supplied to the custom scheduler 
  65. SchedulerInfoRec        RECORD 0
  66. InfoRecSize                 ds.l    1                ; offset: $0 (0)
  67. CurrentThreadID             ds.l    1                ; offset: $4 (4)
  68. SuggestedThreadID         ds.l    1                ; offset: $8 (8)
  69. InterruptedCoopThreadID     ds.l    1                ; offset: $C (12)
  70. sizeof                     EQU *                    ; size:   $10 (16)
  71.                         ENDR
  72. ; typedef struct SchedulerInfoRec *        SchedulerInfoRecPtr
  73.  
  74.  
  75.     IF TARGET_CPU_68K ** TARGET_RT_MAC_CFM THEN
  76. ; 
  77. ;    The following UniversalProcPtrs are for CFM-68k compatiblity with
  78. ;    the implementation of the Thread Manager.
  79. ;
  80.  
  81. ; typedef UniversalProcPtr                 ThreadEntryProcPtr
  82.  
  83. ; typedef UniversalProcPtr                 ThreadSchedulerProcPtr
  84.  
  85. ; typedef UniversalProcPtr                 ThreadSwitchProcPtr
  86.  
  87. ; typedef UniversalProcPtr                 ThreadTerminationProcPtr
  88.  
  89. ; typedef UniversalProcPtr                 DebuggerNewThreadProcPtr
  90.  
  91. ; typedef UniversalProcPtr                 DebuggerDisposeThreadProcPtr
  92.  
  93. ; typedef UniversalProcPtr                 DebuggerThreadSchedulerProcPtr
  94.  
  95.     ELSE
  96. ; 
  97. ;    The following ProcPtrs cannot be interchanged with UniversalProcPtrs because
  98. ;    of differences between 680x0 and PowerPC runtime architectures with regard to
  99. ;    the implementation of the Thread Manager.
  100. ; 
  101.  
  102. ;  Prototype for thread's entry (main) routine 
  103. ; typedef void *                        voidPtr
  104.  
  105. ;  Prototype for custom thread scheduler routine 
  106. ;  Prototype for custom thread switcher routine 
  107. ;  Prototype for thread termination notification routine 
  108. ;  Prototype for debugger NewThread notification 
  109. ;  Prototype for debugger DisposeThread notification 
  110. ;  Prototype for debugger schedule notification 
  111.     ENDIF
  112.  
  113. ;  Thread Manager routines 
  114. ;
  115. ; pascal OSErr CreateThreadPool(ThreadStyle threadStyle, short numToCreate, Size stackSize)
  116. ;
  117.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  118.         Macro
  119.         _CreateThreadPool
  120.             move.w              #$0501,D0
  121.             dc.w                $ABF2
  122.         EndM
  123.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  124.         IMPORT_CFM_FUNCTION CreateThreadPool
  125.     ENDIF
  126.  
  127. ;
  128. ; pascal OSErr GetFreeThreadCount(ThreadStyle threadStyle, short *freeCount)
  129. ;
  130.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  131.         Macro
  132.         _GetFreeThreadCount
  133.             move.w              #$0402,D0
  134.             dc.w                $ABF2
  135.         EndM
  136.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  137.         IMPORT_CFM_FUNCTION GetFreeThreadCount
  138.     ENDIF
  139.  
  140. ;
  141. ; pascal OSErr GetSpecificFreeThreadCount(ThreadStyle threadStyle, Size stackSize, short *freeCount)
  142. ;
  143.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  144.         Macro
  145.         _GetSpecificFreeThreadCount
  146.             move.w              #$0615,D0
  147.             dc.w                $ABF2
  148.         EndM
  149.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  150.         IMPORT_CFM_FUNCTION GetSpecificFreeThreadCount
  151.     ENDIF
  152.  
  153. ;
  154. ; pascal OSErr GetDefaultThreadStackSize(ThreadStyle threadStyle, Size *stackSize)
  155. ;
  156.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  157.         Macro
  158.         _GetDefaultThreadStackSize
  159.             move.w              #$0413,D0
  160.             dc.w                $ABF2
  161.         EndM
  162.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  163.         IMPORT_CFM_FUNCTION GetDefaultThreadStackSize
  164.     ENDIF
  165.  
  166. ;
  167. ; pascal OSErr ThreadCurrentStackSpace(ThreadID thread, unsigned long *freeStack)
  168. ;
  169.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  170.         Macro
  171.         _ThreadCurrentStackSpace
  172.             move.w              #$0414,D0
  173.             dc.w                $ABF2
  174.         EndM
  175.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  176.         IMPORT_CFM_FUNCTION ThreadCurrentStackSpace
  177.     ENDIF
  178.  
  179. ;
  180. ; pascal OSErr NewThread(ThreadStyle threadStyle, ThreadEntryProcPtr threadEntry, void *threadParam, Size stackSize, ThreadOptions options, void **threadResult, ThreadID *threadMade)
  181. ;
  182.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  183.         Macro
  184.         _NewThread
  185.             move.w              #$0E03,D0
  186.             dc.w                $ABF2
  187.         EndM
  188.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  189.         IMPORT_CFM_FUNCTION NewThread
  190.     ENDIF
  191.  
  192. ;
  193. ; pascal OSErr DisposeThread(ThreadID threadToDump, void *threadResult, Boolean recycleThread)
  194. ;
  195.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  196.         Macro
  197.         _DisposeThread
  198.             move.w              #$0504,D0
  199.             dc.w                $ABF2
  200.         EndM
  201.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  202.         IMPORT_CFM_FUNCTION DisposeThread
  203.     ENDIF
  204.  
  205. ;
  206. ; pascal OSErr YieldToThread(ThreadID suggestedThread)
  207. ;
  208.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  209.         Macro
  210.         _YieldToThread
  211.             move.w              #$0205,D0
  212.             dc.w                $ABF2
  213.         EndM
  214.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  215.         IMPORT_CFM_FUNCTION YieldToThread
  216.     ENDIF
  217.  
  218. ;
  219. ; pascal OSErr YieldToAnyThread(void )
  220. ;
  221.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  222.         Macro
  223.         _YieldToAnyThread
  224.             clr.l               -(sp)
  225.             move.w              #$0205,D0
  226.             dc.w                $ABF2
  227.         EndM
  228.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  229.         IMPORT_CFM_FUNCTION YieldToAnyThread
  230.     ENDIF
  231.  
  232. ;
  233. ; pascal OSErr GetCurrentThread(ThreadID *currentThreadID)
  234. ;
  235.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  236.         Macro
  237.         _GetCurrentThread
  238.             move.w              #$0206,D0
  239.             dc.w                $ABF2
  240.         EndM
  241.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  242.         IMPORT_CFM_FUNCTION GetCurrentThread
  243.     ENDIF
  244.  
  245. ;
  246. ; pascal OSErr GetThreadState(ThreadID threadToGet, ThreadState *threadState)
  247. ;
  248.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  249.         Macro
  250.         _GetThreadState
  251.             move.w              #$0407,D0
  252.             dc.w                $ABF2
  253.         EndM
  254.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  255.         IMPORT_CFM_FUNCTION GetThreadState
  256.     ENDIF
  257.  
  258. ;
  259. ; pascal OSErr SetThreadState(ThreadID threadToSet, ThreadState newState, ThreadID suggestedThread)
  260. ;
  261.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  262.         Macro
  263.         _SetThreadState
  264.             move.w              #$0508,D0
  265.             dc.w                $ABF2
  266.         EndM
  267.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  268.         IMPORT_CFM_FUNCTION SetThreadState
  269.     ENDIF
  270.  
  271. ;
  272. ; pascal OSErr SetThreadStateEndCritical(ThreadID threadToSet, ThreadState newState, ThreadID suggestedThread)
  273. ;
  274.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  275.         Macro
  276.         _SetThreadStateEndCritical
  277.             move.w              #$0512,D0
  278.             dc.w                $ABF2
  279.         EndM
  280.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  281.         IMPORT_CFM_FUNCTION SetThreadStateEndCritical
  282.     ENDIF
  283.  
  284. ;
  285. ; pascal OSErr SetThreadScheduler(ThreadSchedulerProcPtr threadScheduler)
  286. ;
  287.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  288.         Macro
  289.         _SetThreadScheduler
  290.             move.w              #$0209,D0
  291.             dc.w                $ABF2
  292.         EndM
  293.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  294.         IMPORT_CFM_FUNCTION SetThreadScheduler
  295.     ENDIF
  296.  
  297. ;
  298. ; pascal OSErr SetThreadSwitcher(ThreadID thread, ThreadSwitchProcPtr threadSwitcher, void *switchProcParam, Boolean inOrOut)
  299. ;
  300.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  301.         Macro
  302.         _SetThreadSwitcher
  303.             move.w              #$070A,D0
  304.             dc.w                $ABF2
  305.         EndM
  306.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  307.         IMPORT_CFM_FUNCTION SetThreadSwitcher
  308.     ENDIF
  309.  
  310. ;
  311. ; pascal OSErr SetThreadTerminator(ThreadID thread, ThreadTerminationProcPtr threadTerminator, void *terminationProcParam)
  312. ;
  313.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  314.         Macro
  315.         _SetThreadTerminator
  316.             move.w              #$0611,D0
  317.             dc.w                $ABF2
  318.         EndM
  319.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  320.         IMPORT_CFM_FUNCTION SetThreadTerminator
  321.     ENDIF
  322.  
  323. ;
  324. ; pascal OSErr ThreadBeginCritical(void )
  325. ;
  326.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  327.         Macro
  328.         _ThreadBeginCritical
  329.             move.w              #$000B,D0
  330.             dc.w                $ABF2
  331.         EndM
  332.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  333.         IMPORT_CFM_FUNCTION ThreadBeginCritical
  334.     ENDIF
  335.  
  336. ;
  337. ; pascal OSErr ThreadEndCritical(void )
  338. ;
  339.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  340.         Macro
  341.         _ThreadEndCritical
  342.             move.w              #$000C,D0
  343.             dc.w                $ABF2
  344.         EndM
  345.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  346.         IMPORT_CFM_FUNCTION ThreadEndCritical
  347.     ENDIF
  348.  
  349. ;
  350. ; pascal OSErr SetDebuggerNotificationProcs(DebuggerNewThreadProcPtr notifyNewThread, DebuggerDisposeThreadProcPtr notifyDisposeThread, DebuggerThreadSchedulerProcPtr notifyThreadScheduler)
  351. ;
  352.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  353.         Macro
  354.         _SetDebuggerNotificationProcs
  355.             move.w              #$060D,D0
  356.             dc.w                $ABF2
  357.         EndM
  358.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  359.         IMPORT_CFM_FUNCTION SetDebuggerNotificationProcs
  360.     ENDIF
  361.  
  362. ;
  363. ; pascal OSErr GetThreadCurrentTaskRef(ThreadTaskRef *threadTRef)
  364. ;
  365.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  366.         Macro
  367.         _GetThreadCurrentTaskRef
  368.             move.w              #$020E,D0
  369.             dc.w                $ABF2
  370.         EndM
  371.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  372.         IMPORT_CFM_FUNCTION GetThreadCurrentTaskRef
  373.     ENDIF
  374.  
  375. ;
  376. ; pascal OSErr GetThreadStateGivenTaskRef(ThreadTaskRef threadTRef, ThreadID threadToGet, ThreadState *threadState)
  377. ;
  378.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  379.         Macro
  380.         _GetThreadStateGivenTaskRef
  381.             move.w              #$060F,D0
  382.             dc.w                $ABF2
  383.         EndM
  384.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  385.         IMPORT_CFM_FUNCTION GetThreadStateGivenTaskRef
  386.     ENDIF
  387.  
  388. ;
  389. ; pascal OSErr SetThreadReadyGivenTaskRef(ThreadTaskRef threadTRef, ThreadID threadToSet)
  390. ;
  391.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  392.         Macro
  393.         _SetThreadReadyGivenTaskRef
  394.             move.w              #$0410,D0
  395.             dc.w                $ABF2
  396.         EndM
  397.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  398.         IMPORT_CFM_FUNCTION SetThreadReadyGivenTaskRef
  399.     ENDIF
  400.  
  401.     ENDIF ; __THREADS__ 
  402.  
  403.